<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
    <title>ShellCheck: SC2213 – getopts specified `-n`, but it's not handled by this `case`.</title>
    <link rel="stylesheet" href="css/bootstrap.min.css" />
  </head>
  <body style="margin-left: auto; margin-right: auto; max-width: 800px">
    <h1>SC2213 – ShellCheck Wiki</h1>
    <a href="https://github.com/koalaman/shellcheck/wiki/SC2213">See this page on GitHub</a>
    <p style="display: none"><a href="index.html">Sitemap</a></p>
    <hr />
    <h2 id="getopts-specified--n-but-its-not-handled-by-this-case">getopts
specified <code>-n</code>, but it's not handled by this
<code>case</code>.</h2>
<h3 id="problematic-code">Problematic code:</h3>
<div class="sourceCode" id="cb1"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb1-1"><a href="SC2213.html#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="cf">while</span> <span class="bu">getopts</span> <span class="st">&quot;vrn&quot;</span> <span class="va">n</span></span>
<span id="cb1-2"><a href="SC2213.html#cb1-2" aria-hidden="true" tabindex="-1"></a><span class="cf">do</span></span>
<span id="cb1-3"><a href="SC2213.html#cb1-3" aria-hidden="true" tabindex="-1"></a>  <span class="cf">case</span> <span class="st">&quot;</span><span class="va">$n</span><span class="st">&quot;</span> <span class="kw">in</span></span>
<span id="cb1-4"><a href="SC2213.html#cb1-4" aria-hidden="true" tabindex="-1"></a>    <span class="ss">v</span><span class="kw">)</span> <span class="bu">echo</span> <span class="st">&quot;Verbose&quot;</span> <span class="cf">;;</span></span>
<span id="cb1-5"><a href="SC2213.html#cb1-5" aria-hidden="true" tabindex="-1"></a>    <span class="ss">r</span><span class="kw">)</span> <span class="bu">echo</span> <span class="st">&quot;Recursive&quot;</span> <span class="cf">;;</span></span>
<span id="cb1-6"><a href="SC2213.html#cb1-6" aria-hidden="true" tabindex="-1"></a>    <span class="dt">\?</span><span class="kw">)</span> <span class="ex">usage</span><span class="cf">;;</span></span>
<span id="cb1-7"><a href="SC2213.html#cb1-7" aria-hidden="true" tabindex="-1"></a>  <span class="cf">esac</span></span>
<span id="cb1-8"><a href="SC2213.html#cb1-8" aria-hidden="true" tabindex="-1"></a><span class="cf">done</span></span></code></pre></div>
<h3 id="correct-code">Correct code:</h3>
<div class="sourceCode" id="cb2"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb2-1"><a href="SC2213.html#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="cf">while</span> <span class="bu">getopts</span> <span class="st">&quot;vrn&quot;</span> <span class="va">n</span></span>
<span id="cb2-2"><a href="SC2213.html#cb2-2" aria-hidden="true" tabindex="-1"></a><span class="cf">do</span></span>
<span id="cb2-3"><a href="SC2213.html#cb2-3" aria-hidden="true" tabindex="-1"></a>  <span class="cf">case</span> <span class="st">&quot;</span><span class="va">$n</span><span class="st">&quot;</span> <span class="kw">in</span></span>
<span id="cb2-4"><a href="SC2213.html#cb2-4" aria-hidden="true" tabindex="-1"></a>    <span class="ss">v</span><span class="kw">)</span> <span class="bu">echo</span> <span class="st">&quot;Verbose&quot;</span> <span class="cf">;;</span></span>
<span id="cb2-5"><a href="SC2213.html#cb2-5" aria-hidden="true" tabindex="-1"></a>    <span class="ss">r</span><span class="kw">)</span> <span class="bu">echo</span> <span class="st">&quot;Recursive&quot;</span> <span class="cf">;;</span></span>
<span id="cb2-6"><a href="SC2213.html#cb2-6" aria-hidden="true" tabindex="-1"></a>    <span class="ss">n</span><span class="kw">)</span> <span class="bu">echo</span> <span class="st">&quot;Dry-run&quot;</span> <span class="cf">;;</span>    <span class="co"># -n handled here</span></span>
<span id="cb2-7"><a href="SC2213.html#cb2-7" aria-hidden="true" tabindex="-1"></a>    <span class="dt">\?</span><span class="kw">)</span> <span class="ex">usage</span><span class="cf">;;</span></span>
<span id="cb2-8"><a href="SC2213.html#cb2-8" aria-hidden="true" tabindex="-1"></a>  <span class="cf">esac</span></span>
<span id="cb2-9"><a href="SC2213.html#cb2-9" aria-hidden="true" tabindex="-1"></a><span class="cf">done</span></span></code></pre></div>
<h3 id="rationale">Rationale:</h3>
<p>You have a <code>while getopts</code> loop where the corresponding
<code>case</code> statement fails to handle one of the flags.</p>
<p>Either add a case to handle the flag, or remove it from the
<code>getopts</code> option string.</p>
<h3 id="exceptions">Exceptions:</h3>
<p>ShellCheck may not correctly recognize less canonical uses of
<code>while getopts ..; do case ..;</code>, such as when modifying the
variable before using it:</p>
<pre><code>while getopts &quot;rf-:&quot; OPT; do
  if [ &quot;$OPT&quot; = &quot;-&quot; ]; then   # long option: reformulate OPT and OPTARG
    OPT=&quot;${OPTARG%%=*}&quot;       # extract long option name
    OPTARG=&quot;${OPTARG#$OPT}&quot;   # extract long option argument (may be empty)
    OPTARG=&quot;${OPTARG#=}&quot;      # if long option argument, remove assigning `=`
  fi

  case &quot;$OPT&quot; in
    r) ... ;;
    f) ... ;;
    my-long-option) ... ;;
  esac
done</code></pre>
<p>In such cases you can do one of:</p>
<ul>
<li><a href="Ignore.html">Ignore</a> the warning.</li>
<li>Use the external tool <code>getopt</code> (no "s") which supports
long options natively.</li>
<li>Rewrite to not modify the variable first, in this case by instead
doing it in a <code>-)</code> branch.</li>
</ul>
    <hr />
    <p style='font-size: 80%'><a href="../index.html">ShellCheck</a> is a static analysis tool for shell scripts. This page is part of its documentation.</p>
  </body>
</html>


